Platform Explorer / Nuxeo Platform 2023.19

Component org.nuxeo.ecm.platform.query.api.PageProviderService

In bundle org.nuxeo.ecm.platform.query.api

Documentation

The Page Provider service provides extension points for page providers registration.

Resolution Order

461
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Start Order

866
The start order represents the order in which this component has been started by the Nuxeo Runtime framework.
This number is interesting to tweak if your Java component interacts with other components, and needs to be started before or after another one.
It can be changed by implementing the method "Component#getApplicationStartedOrder()" on your Java component: components are sorted according to this reference value, in increasing order.
The default value is 1000, and the repository initialization uses number 100. Negative values can also be used.

Implementation

Class: org.nuxeo.ecm.platform.query.core.PageProviderServiceImpl

Services

Extension Points

Contributions

XML Source

<?xml version="1.0"?>

<component name="org.nuxeo.ecm.platform.query.api.PageProviderService">

  <documentation>
    The Page Provider service provides extension points for page providers
    registration.

    @author Anahide Tchertchian (at@nuxeo.com)
  </documentation>

  <implementation
    class="org.nuxeo.ecm.platform.query.core.PageProviderServiceImpl" />

  <service>
    <provide interface="org.nuxeo.ecm.platform.query.api.PageProviderService" />
  </service>

  <extension-point name="providers">
    <object
      class="org.nuxeo.ecm.platform.query.core.CoreQueryPageProviderDescriptor" />
    <object
      class="org.nuxeo.ecm.platform.query.core.GenericPageProviderDescriptor" />
  </extension-point>

  <extension-point name="replacers">
    <object
      class="org.nuxeo.ecm.platform.query.core.PageProviderClassReplacerDescriptor" />
  </extension-point>

  <extension target="org.nuxeo.runtime.ConfigurationService" point="configuration">
    <documentation>
      Properties for core queries behaviors:
      <ul>
        <li>org.nuxeo.query.builder.ignored.chars: defines what characters that
          are escaped in core queries.</li>
        <li>
          org.nuxeo.ecm.platform.query.nxql.defaultNavigationResults:
          <a href="https://doc.nuxeo.com/x/FQ4z#ContentViews-maxresults"
            target="_blank">
            Maximum number of results for page providers.
          </a>
        </li>
      </ul>
    </documentation>
    <property name="org.nuxeo.query.builder.ignored.chars">!#$%&amp;'()+,./\\\\:-@{|}`^~</property>
    <property name="org.nuxeo.ecm.platform.query.nxql.defaultNavigationResults">200</property>
  </extension>

</component>